

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>nlp_architect.models.cross_doc_coref.system.sieves package &mdash; NLP Architect by Intel® AI Lab 0.5.2 documentation</title>
  

  
  
  
  

  
  <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
        <script type="text/javascript" src="../_static/jquery.js"></script>
        <script type="text/javascript" src="../_static/underscore.js"></script>
        <script type="text/javascript" src="../_static/doctools.js"></script>
        <script type="text/javascript" src="../_static/language_data.js"></script>
        <script type="text/javascript" src="../_static/install.js"></script>
        <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
    
    <script type="text/javascript" src="../_static/js/theme.js"></script>

    

  
  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="../_static/nlp_arch_theme.css" type="text/css" />
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto+Mono" type="text/css" />
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:100,900" type="text/css" />
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="nlp_architect.models.transformers package" href="nlp_architect.models.transformers.html" />
    <link rel="prev" title="nlp_architect.models.cross_doc_coref.system package" href="nlp_architect.models.cross_doc_coref.system.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="../index.html">
          

          
            
            <img src="../_static/logo.png" class="logo" alt="Logo"/>
          
          </a>

          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <ul>
<li class="toctree-l1"><a class="reference internal" href="../quick_start.html">Quick start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../publications.html">Publications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials.html">Jupyter Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../model_zoo.html">Model Zoo</a></li>
</ul>
<p class="caption"><span class="caption-text">NLP/NLU Models</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../tagging/sequence_tagging.html">Sequence Tagging</a></li>
<li class="toctree-l1"><a class="reference internal" href="../sentiment.html">Sentiment Analysis</a></li>
<li class="toctree-l1"><a class="reference internal" href="../bist_parser.html">Dependency Parsing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../intent.html">Intent Extraction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../lm.html">Language Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../information_extraction.html">Information Extraction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../transformers.html">Transformers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../archived/additional.html">Additional Models</a></li>
</ul>
<p class="caption"><span class="caption-text">Optimized Models</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../quantized_bert.html">Quantized BERT</a></li>
<li class="toctree-l1"><a class="reference internal" href="../transformers_distillation.html">Transformers Distillation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../sparse_gnmt.html">Sparse Neural Machine Translation</a></li>
</ul>
<p class="caption"><span class="caption-text">Solutions</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../absa_solution.html">Aspect Based Sentiment Analysis</a></li>
<li class="toctree-l1"><a class="reference internal" href="../term_set_expansion.html">Set Expansion</a></li>
<li class="toctree-l1"><a class="reference internal" href="../trend_analysis.html">Trend Analysis</a></li>
</ul>
<p class="caption"><span class="caption-text">For Developers</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="nlp_architect_api_index.html">nlp_architect API</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="nlp_architect.api.html">nlp_architect.api package</a></li>
<li class="toctree-l2"><a class="reference internal" href="nlp_architect.cli.html">nlp_architect.cli package</a></li>
<li class="toctree-l2"><a class="reference internal" href="nlp_architect.common.html">nlp_architect.common package</a></li>
<li class="toctree-l2"><a class="reference internal" href="nlp_architect.data.html">nlp_architect.data package</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="nlp_architect.models.html">nlp_architect.models package</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="nlp_architect.models.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="nlp_architect.models.absa.html">nlp_architect.models.absa package</a></li>
<li class="toctree-l4"><a class="reference internal" href="nlp_architect.models.bist.html">nlp_architect.models.bist package</a></li>
<li class="toctree-l4 current"><a class="reference internal" href="nlp_architect.models.cross_doc_coref.html">nlp_architect.models.cross_doc_coref package</a></li>
<li class="toctree-l4"><a class="reference internal" href="nlp_architect.models.transformers.html">nlp_architect.models.transformers package</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="nlp_architect.models.html#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="nlp_architect.models.html#module-nlp_architect.models.bist_parser">nlp_architect.models.bist_parser module</a></li>
<li class="toctree-l3"><a class="reference internal" href="nlp_architect.models.html#module-nlp_architect.models.chunker">nlp_architect.models.chunker module</a></li>
<li class="toctree-l3"><a class="reference internal" href="nlp_architect.models.html#module-nlp_architect.models.cross_doc_sieves">nlp_architect.models.cross_doc_sieves module</a></li>
<li class="toctree-l3"><a class="reference internal" href="nlp_architect.models.html#module-nlp_architect.models.crossling_emb">nlp_architect.models.crossling_emb module</a></li>
<li class="toctree-l3"><a class="reference internal" href="nlp_architect.models.html#module-nlp_architect.models.intent_extraction">nlp_architect.models.intent_extraction module</a></li>
<li class="toctree-l3"><a class="reference internal" href="nlp_architect.models.html#module-nlp_architect.models.most_common_word_sense">nlp_architect.models.most_common_word_sense module</a></li>
<li class="toctree-l3"><a class="reference internal" href="nlp_architect.models.html#module-nlp_architect.models.ner_crf">nlp_architect.models.ner_crf module</a></li>
<li class="toctree-l3"><a class="reference internal" href="nlp_architect.models.html#module-nlp_architect.models.np2vec">nlp_architect.models.np2vec module</a></li>
<li class="toctree-l3"><a class="reference internal" href="nlp_architect.models.html#module-nlp_architect.models.np_semantic_segmentation">nlp_architect.models.np_semantic_segmentation module</a></li>
<li class="toctree-l3"><a class="reference internal" href="nlp_architect.models.html#module-nlp_architect.models.pretrained_models">nlp_architect.models.pretrained_models module</a></li>
<li class="toctree-l3"><a class="reference internal" href="nlp_architect.models.html#module-nlp_architect.models.tagging">nlp_architect.models.tagging module</a></li>
<li class="toctree-l3"><a class="reference internal" href="nlp_architect.models.html#module-nlp_architect.models.temporal_convolutional_network">nlp_architect.models.temporal_convolutional_network module</a></li>
<li class="toctree-l3"><a class="reference internal" href="nlp_architect.models.html#module-nlp_architect.models">Module contents</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="nlp_architect.nlp.html">nlp_architect.nlp package</a></li>
<li class="toctree-l2"><a class="reference internal" href="nlp_architect.nn.html">nlp_architect.nn package</a></li>
<li class="toctree-l2"><a class="reference internal" href="nlp_architect.pipelines.html">nlp_architect.pipelines package</a></li>
<li class="toctree-l2"><a class="reference internal" href="nlp_architect.procedures.html">nlp_architect.procedures package</a></li>
<li class="toctree-l2"><a class="reference internal" href="nlp_architect.utils.html">nlp_architect.utils package</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../developer_guide.html">Developer Guide</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../index.html">NLP Architect by Intel® AI Lab</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../index.html">Docs</a> &raquo;</li>
        
          <li><a href="nlp_architect_api_index.html"><code class="docutils literal notranslate"><span class="pre">nlp\_architect</span></code> package</a> &raquo;</li>
        
          <li><a href="nlp_architect.models.html">nlp_architect.models package</a> &raquo;</li>
        
          <li><a href="nlp_architect.models.cross_doc_coref.html">nlp_architect.models.cross_doc_coref package</a> &raquo;</li>
        
          <li><a href="nlp_architect.models.cross_doc_coref.system.html">nlp_architect.models.cross_doc_coref.system package</a> &raquo;</li>
        
      <li>nlp_architect.models.cross_doc_coref.system.sieves package</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="nlp-architect-models-cross-doc-coref-system-sieves-package">
<h1>nlp_architect.models.cross_doc_coref.system.sieves package<a class="headerlink" href="#nlp-architect-models-cross-doc-coref-system-sieves-package" title="Permalink to this headline">¶</a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
</div>
<div class="section" id="module-nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system">
<span id="nlp-architect-models-cross-doc-coref-system-sieves-run-sieve-system-module"></span><h2>nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system module<a class="headerlink" href="#module-nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system.RunSystemsEntity">
<em class="property">class </em><code class="descclassname">nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system.</code><code class="descname">RunSystemsEntity</code><span class="sig-paren">(</span><em>topic: nlp_architect.common.cdc.topics.Topic</em>, <em>resources</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nlp_architect/models/cross_doc_coref/system/sieves/run_sieve_system.html#RunSystemsEntity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system.RunSystemsEntity" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system.RunSystemsSuper" title="nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system.RunSystemsSuper"><code class="xref py py-class docutils literal notranslate"><span class="pre">nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system.RunSystemsSuper</span></code></a></p>
</dd></dl>

<dl class="class">
<dt id="nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system.RunSystemsEvent">
<em class="property">class </em><code class="descclassname">nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system.</code><code class="descname">RunSystemsEvent</code><span class="sig-paren">(</span><em>topic</em>, <em>resources</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nlp_architect/models/cross_doc_coref/system/sieves/run_sieve_system.html#RunSystemsEvent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system.RunSystemsEvent" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system.RunSystemsSuper" title="nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system.RunSystemsSuper"><code class="xref py py-class docutils literal notranslate"><span class="pre">nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system.RunSystemsSuper</span></code></a></p>
</dd></dl>

<dl class="class">
<dt id="nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system.RunSystemsSuper">
<em class="property">class </em><code class="descclassname">nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system.</code><code class="descname">RunSystemsSuper</code><span class="sig-paren">(</span><em>topic: nlp_architect.common.cdc.topics.Topic</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nlp_architect/models/cross_doc_coref/system/sieves/run_sieve_system.html#RunSystemsSuper"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system.RunSystemsSuper" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="method">
<dt id="nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system.RunSystemsSuper.get_results">
<code class="descname">get_results</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nlp_architect/models/cross_doc_coref/system/sieves/run_sieve_system.html#RunSystemsSuper.get_results"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system.RunSystemsSuper.get_results" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system.RunSystemsSuper.run_deterministic">
<code class="descname">run_deterministic</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nlp_architect/models/cross_doc_coref/system/sieves/run_sieve_system.html#RunSystemsSuper.run_deterministic"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system.RunSystemsSuper.run_deterministic" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="staticmethod">
<dt id="nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system.RunSystemsSuper.set_sieves_from_config">
<em class="property">static </em><code class="descname">set_sieves_from_config</code><span class="sig-paren">(</span><em>config</em>, <em>get_rel_extraction</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nlp_architect/models/cross_doc_coref/system/sieves/run_sieve_system.html#RunSystemsSuper.set_sieves_from_config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system.RunSystemsSuper.set_sieves_from_config" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="function">
<dt id="nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system.get_run_system">
<code class="descclassname">nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system.</code><code class="descname">get_run_system</code><span class="sig-paren">(</span><em>topic: nlp_architect.common.cdc.topics.Topic</em>, <em>resource: nlp_architect.models.cross_doc_coref.system.sieves_container_init.SievesContainerInitialization</em>, <em>eval_type: str</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nlp_architect/models/cross_doc_coref/system/sieves/run_sieve_system.html#get_run_system"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nlp_architect.models.cross_doc_coref.system.sieves.run_sieve_system.get_run_system" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</div>
<div class="section" id="module-nlp_architect.models.cross_doc_coref.system.sieves.sieves">
<span id="nlp-architect-models-cross-doc-coref-system-sieves-sieves-module"></span><h2>nlp_architect.models.cross_doc_coref.system.sieves.sieves module<a class="headerlink" href="#module-nlp_architect.models.cross_doc_coref.system.sieves.sieves" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="nlp_architect.models.cross_doc_coref.system.sieves.sieves.SieveClusterMerger">
<em class="property">class </em><code class="descclassname">nlp_architect.models.cross_doc_coref.system.sieves.sieves.</code><code class="descname">SieveClusterMerger</code><span class="sig-paren">(</span><em>excepted_relation: Tuple[nlp_architect.data.cdc_resources.relations.relation_types_enums.RelationType, float], relation_extractor: nlp_architect.data.cdc_resources.relations.relation_extraction.RelationExtraction</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/nlp_architect/models/cross_doc_coref/system/sieves/sieves.html#SieveClusterMerger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nlp_architect.models.cross_doc_coref.system.sieves.sieves.SieveClusterMerger" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="method">
<dt id="nlp_architect.models.cross_doc_coref.system.sieves.sieves.SieveClusterMerger.run_sieve">
<code class="descname">run_sieve</code><span class="sig-paren">(</span><em>cluster_i: nlp_architect.common.cdc.cluster.Cluster</em>, <em>cluster_j: nlp_architect.common.cdc.cluster.Cluster</em><span class="sig-paren">)</span> &#x2192; bool<a class="reference internal" href="../_modules/nlp_architect/models/cross_doc_coref/system/sieves/sieves.html#SieveClusterMerger.run_sieve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nlp_architect.models.cross_doc_coref.system.sieves.sieves.SieveClusterMerger.run_sieve" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>cluster_i</strong> – </li>
<li><strong>cluster_j</strong> – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">bool -&gt; indicating whether to merge clusters (True) or not (False)</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="module-nlp_architect.models.cross_doc_coref.system.sieves">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-nlp_architect.models.cross_doc_coref.system.sieves" title="Permalink to this headline">¶</a></h2>
</div>
</div>


           </div>
           
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <p>

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>